Skip to content

feat(chore): add automatic README generation for npm packages #2541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 29, 2025
Merged

feat(chore): add automatic README generation for npm packages #2541

merged 2 commits into from
Oct 29, 2025

Conversation

@jremy42
Copy link
Contributor

@jremy42 jremy42 commented Oct 29, 2025 •
edited
Loading

close 2362

@changeset-bot
Copy link

changeset-bot bot commented Oct 29, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 62c11d5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 0% with 33 lines in your changes missing coverage. Please review.
✅ Project coverage is 4.09%. Comparing base (95e31a5) to head (62c11d5).
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
scripts/helpers.ts 0.00% 18 Missing ⚠️
scripts/generatePackages.ts 0.00% 15 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff            @@
##            main   #2541      +/-   ##
========================================
- Coverage   4.10%   4.09%   -0.01%     
========================================
  Files        431     431              
  Lines      51128   51161      +33     
  Branches     869     869              
========================================
  Hits        2097    2097              
- Misses     49031   49064      +33

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jremy42 jremy42 force-pushed the feat/auto-generate-package-readme branch from 0b25ebe to 0125e40 Compare October 29, 2025 12:26
@jremy42 jremy42 force-pushed the feat/auto-generate-package-readme branch from 0125e40 to c487b93 Compare October 29, 2025 14:04
@jremy42 jremy42 changed the title feat: add automatic README generation for npm packages feat(chore): add automatic README generation for npm packages Oct 29, 2025
@jremy42 jremy42 marked this pull request as ready for review October 29, 2025 14:10
@jremy42 jremy42 requested a review from remyleone as a code owner October 29, 2025 14:10
@remyleone remyleone added this pull request to the merge queue Oct 29, 2025
Merged via the queue into main with commit 7e8f769 Oct 29, 2025
10 checks passed
@remyleone remyleone deleted the feat/auto-generate-package-readme branch October 29, 2025 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@remyleone remyleone remyleone approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add support for README in the different packages we provide

4 participants

@jremy42 @codecov-commenter @remyleone